Resource URL: /platform/<<version=4>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>/interfaces

    Overview: This resource exposes OneFS network interfaces.

     Methods: GET

********************************************************************************

Method GET: Get a list of interfaces.

       URL: GET
            /platform/<<version=4>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>/interfaces

Query arguments:
  sort=<string> The field that will be used for sorting.
  lnns=<string> Get a list of interfaces for the specified lnn.
limit=<integer> Return no more than this many results at once (see resume).
     dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the sort.
resume=<string> Continue returning results from previous call using this token
                (token should come from the previous call, resume cannot be
                used with other options).

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "interface": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "properties": {
              "status": {
                "enum": [
                  "up", 
                  "not_available", 
                  "no_carrier", 
                  "active", 
                  "inactive"
                ], 
                "type": "string", 
                "description": "Status of the interface", 
                "required": true
              }, 
              "owners": {
                "items": {
                  "type": "object", 
                  "properties": {
                    "subnet": {
                      "type": "string"
                    }, 
                    "groupnet": {
                      "type": "string"
                    }, 
                    "pool": {
                      "type": "string"
                    }
                  }
                }, 
                "required": true, 
                "type": "array", 
                "description": "List of owners (membership)"
              }, 
              "name": {
                "required": true, 
                "type": "string", 
                "description": "The name of the interface."
              }, 
              "nic_name": {
                "required": true, 
                "type": "string", 
                "description": "NIC name"
              }, 
              "ip_addrs": {
                "items": {
                  "type": "string"
                }, 
                "required": true, 
                "type": "array", 
                "description": "List of IP addresses"
              }, 
              "lnn": {
                "minimum": 1, 
                "type": "integer", 
                "description": "Logical Node Number", 
                "required": true
              }, 
              "type": {
                "enum": [
                  "any", 
                  "gige", 
                  "fastgige", 
                  "10gige", 
                  "40gige", 
                  "mgmt", 
                  "ib", 
                  "ib_qdr", 
                  "ib_fdr", 
                  "aggregated", 
                  "vlan", 
                  "vmxnet3", 
                  "loopback"
                ], 
                "type": "string", 
                "description": "Interface type.  The '*gige' types stand for 'gigabit ethernet'.  'gige' itself is occasionally also referred to in other places as 'ext' for 'external'.  'ib' and 'ib_qdr' are internal Infiniband interface types.  'vlan' and 'vmxnet3' are virtual interface types that appear on virtual nodes.  'loopback' is an interface for failover addresses and should only appear if failover is configured.", 
                "required": true
              }, 
              "id": {
                "required": true, 
                "type": "string", 
                "description": "Unique interface ID."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "resume": {
          "minLength": 0, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
        }
      }
    }
  ]
}
